Class com.symantec.itools.vcafe.openapi.options.EnvironmentGeneralOptions 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.symantec.itools.vcafe.openapi.options.EnvironmentGeneralOptions 

Object
   |
   +----com.symantec.itools.vcafe.openapi.options.EnvironmentGeneralOptions
public abstract class EnvironmentGeneralOptions
extends Object
The API used to represent and access the general options of the Visual Cafe environment. These options that appear in the "General" tab in the Environment Options dialog.

Use EnvironmentOptionSet.getGeneralOptions() to get an instance of this object.

Version:
1.0
Author:
Symantec Internet Tools Division
Since:
VCafe 3.0
See Also:
getEnvironmentOptionSet, getGeneralOptions

Variable Index

o ONSTARTUP_CREATE_A_NEW_PROJECT
Indicates Visual Cafe will create a new default project on startup.
o ONSTARTUP_DO_NOTHING
Indicates Visual Cafe will take no special action on startup.
o ONSTARTUP_OPEN_THE_LAST_PROJECT
Indicates Visual Cafe will open the project from the last session on startup.

Constructor Index

o com.symantec.itools.vcafe.openapi.options.EnvironmentGeneralOptions()

Method Index

o getLookForSourceFilesInPath()
Gets the path used to locate project source files when they are not in the project directory.
o getOnStartup()
Gets Visual Cafe's current startup action
o getUseTheseHelpFiles()
Gets a list of help files used by the environment.
o isMDIDevelopmentEnvironment()
Determines whether Visual Cafe will use a Multi-Document Interface (MDI) or the original Single-Document Interface (SDI).

Variables

o ONSTARTUP_CREATE_A_NEW_PROJECT 
public static final int ONSTARTUP_CREATE_A_NEW_PROJECT
Indicates Visual Cafe will create a new default project on startup.

See Also:
getOnStartup
o ONSTARTUP_DO_NOTHING 
public static final int ONSTARTUP_DO_NOTHING
Indicates Visual Cafe will take no special action on startup.

See Also:
getOnStartup
o ONSTARTUP_OPEN_THE_LAST_PROJECT 
public static final int ONSTARTUP_OPEN_THE_LAST_PROJECT
Indicates Visual Cafe will open the project from the last session on startup.

See Also:
getOnStartup

Constructors

o EnvironmentGeneralOptions 
public EnvironmentGeneralOptions()

Methods

o getLookForSourceFilesInPath 
public abstract java.lang.String getLookForSourceFilesInPath()
Gets the path used to locate project source files when they are not in the project directory.

Returns:
the path.
o getOnStartup 
public abstract int getOnStartup()
Gets Visual Cafe's current startup action

Returns:
One of:
  • ONSTARTUP_CREATE_A_NEW_PROJECT - create a new default project,
  • ONSTARTUP_OPEN_THE_LAST_PROJECT - open the project from the last session, or
  • ONSTARTUP_DO_NOTHING - take no special action.
o getUseTheseHelpFiles 
public abstract java.lang.String getUseTheseHelpFiles()
Gets a list of help files used by the environment.

The help filenames are seperated by spaces.

Returns:
the list of help files.
o isMDIDevelopmentEnvironment 
public abstract boolean isMDIDevelopmentEnvironment()
Determines whether Visual Cafe will use a Multi-Document Interface (MDI) or the original Single-Document Interface (SDI). The SDI environment was used exclusively before Visual Cafe 2.5.

Returns:
true if using MDI, false otherwise. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index